Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document fix: add note for connection resource, options schema #1114

Merged
merged 2 commits into from
Jan 29, 2025
Merged

Document fix: add note for connection resource, options schema #1114

merged 2 commits into from
Jan 29, 2025

Conversation

sugitak
Copy link
Contributor

@sugitak sugitak commented Jan 9, 2025 •
edited
Loading

🔧 Changes

Document fix.
When adding options schema in auth0_connection, you need to explicitly define all existing configurations.

📚 References

Regarding #1111

🔬 Testing

Checked I could generate docs by using:

make docs

📝 Checklist

  • All new/changed/fixed functionality is covered by tests (or N/A)
  • I have added documentation for all new/changed functionality (or N/A)

both checked since only documents are updated and no tests are affected.

Note

When creating docs by make docs, I found an unrelated diff to be generated as below:

diff --git a/docs/resources/prompt_custom_text.md b/docs/resources/prompt_custom_text.md
index f444c923..a272409e 100644
--- a/docs/resources/prompt_custom_text.md
+++ b/docs/resources/prompt_custom_text.md
@@ -48,7 +48,7 @@ resource "auth0_prompt_custom_text" "example" {
 ### Required

 - `body` (String) JSON containing the custom texts. You can check the options for each prompt [here](https://auth0.com/docs/customize/universal-login-pages/customize-login-text-prompts#prompt-values).
-- `language` (String) Language of the custom text. Options include: `ar`, `ar-EG`, `ar-SA`, `az`, `bg`, `bs`, `ca-ES`, `cs`, `cy`, `da`, `de`, `el`, `en`, `es`, `es-AR`, `es-MX`, `et`, `eu-ES`, `fa`, `fi`, `fr`, `fr-CA`, `fr-FR`, `gl-ES`, `he`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `ja`, `ko`, `lt`, `lv`, `ms`, `nb`, `nl`, `nn`, `no`, `pl`, `pt`, `pt-BR`, `pt-PT`, `ro`, `ru`, `sk`, `sl`, `sq`, `sr`, `sv`, `th`, `tl`, `tr`, `uk`, `ur`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`.
+- `language` (String) Language of the custom text. Options include: `am`, `ar`, `ar-EG`, `ar-SA`, `az`, `bg`, `bn`, `bs`, `ca-ES`, `cnr`, `cs`, `cy`, `da`, `de`, `el`, `en`, `en-CA`, `es`, `es-419`, `es-AR`, `es-MX`, `et`, `eu-ES`, `fa`, `fi`, `fr`, `fr-CA`, `fr-FR`, `gl-ES`, `gu`, `he`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `ja`, `ka`, `kk`, `kn`, `ko`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `my`, `nb`, `nl`, `nn`, `no`, `pa`, `pl`, `pt`, `pt-BR`, `pt-PT`, `ro`, `ru`, `sk`, `sl`, `so`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tl`, `tr`, `uk`, `ur`, `vi`, `zgh`, `zh-CN`, `zh-HK`, `zh-TW`.
 - `prompt` (String) The term `prompt` is used to refer to a specific step in the login flow. Options include: `captcha`, `common`, `consent`, `custom-form`, `customized-consent`, `device-flow`, `email-otp-challenge`, `email-verification`, `invitation`, `login`, `login-email-verification`, `login-id`, `login-password`, `login-passwordless`, `logout`, `mfa`, `mfa-email`, `mfa-otp`, `mfa-phone`, `mfa-push`, `mfa-recovery-code`, `mfa-sms`, `mfa-voice`, `mfa-webauthn`, `organizations`, `passkeys`, `phone-identifier-challenge`, `phone-identifier-enrollment`, `reset-password`, `signup`, `signup-id`, `signup-password`, `status`.

This diff is not included in this pull request.

@sugitak sugitak requested a review from a team as a code owner January 9, 2025 12:17
@pushpinderbal pushpinderbal mentioned this pull request Jan 15, 2025
Closed
6 tasks
@sugitak sugitak force-pushed the docs-add-note-on-connection branch from e2e3dff to 4420168 Compare January 27, 2025 01:26
@ramya18101 ramya18101 mentioned this pull request Jan 27, 2025
Closed
6 tasks
@duedares-rvj
Copy link
Contributor

About the language change in the docs:
We use a cdn url to fetch the most updated list, so whenever new languages are added, we cut an independent PR with only this change , and merge it to main.
Once this is done, we can rebase our feature branch and the diff won't show up.

Since @ramya18101 is assisting with 1111, she could take it from here.
@sugitak Thanks again for your contribution.

@ramya18101 ramya18101 enabled auto-merge (squash) January 28, 2025 10:55
@ramya18101 ramya18101 disabled auto-merge January 28, 2025 11:00
@ramya18101
Copy link
Contributor

ramya18101 commented Jan 28, 2025 •
edited
Loading

I have approved the changes @sugitak , But Inorder to merge this, we need to have the commit to get signed. Please take a look of this, to get the commit signature verified

@sugitak sugitak force-pushed the docs-add-note-on-connection branch from 4420168 to 601b84c Compare January 29, 2025 08:04
@sugitak sugitak force-pushed the docs-add-note-on-connection branch from 601b84c to f3ff8db Compare January 29, 2025 08:10
@sugitak
Copy link
Contributor Author

sugitak commented Jan 29, 2025

@ramya18101 Thank you for the guide, I have re-committed with the gpg-key now!

@duedares-rvj duedares-rvj merged commit 8f96c65 into auth0:main Jan 29, 2025
5 of 6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ramya18101 ramya18101 ramya18101 approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@sugitak @duedares-rvj @ramya18101